<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PelEntryUserComment</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> PelEntryUserComment</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class for a user comment.</p>
<p class="description"><p>This class is used to hold user comments, which can come in several  different character encodings.  The Exif standard specifies a  certain format of the <a href="../PEL/PelTag.html#constUSER_COMMENT">user comment  tag</a>, and this class will make sure that the format is kept.</p><p>The most basic use of this class simply stores an ASCII encoded  string for later retrieval using <a href="../PEL/PelEntryUserComment.html#methodgetValue">getValue</a>:</p><p><div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$entry&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../PEL/PelEntryUserComment.html">PelEntryUserComment</a></span><span class="src-sym">(</span><span class="src-str">'An&nbsp;ASCII&nbsp;string'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;echo&nbsp;<span class="src-var">$entry</span><span class="src-sym">-&gt;</span><a href="../PEL/PelEntryUserComment.html#methodgetValue">getValue</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p>The string can be encoded with a different encoding, and if so, the  encoding must be given using the second argument.  The Exif  standard specifies three known encodings: 'ASCII', 'JIS', and  'Unicode'.  If the user comment is encoded using a character  encoding different from the tree known encodings, then the empty  string should be passed as encoding, thereby specifying that the  encoding is undefined.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Martin Geisler &lt;<a href="mailto:mgeisler@users.sourceforge.net">mgeisler@users.sourceforge.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_PelEntryUndefined.php.html">/PelEntryUndefined.php</a> (line <span class="field"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a203">203</a></span>)
		</p>
		
				
		<pre><a href="../PEL/PelEntry.html">PelEntry</a>
   |
   --<a href="../PEL/PelEntryUndefined.html">PelEntryUndefined</a>
      |
      --PelEntryUserComment</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																								<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">PelEntryUserComment</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$comment</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span> = <span class="var-default">'ASCII'</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getEncoding" title="details" class="method-name">getEncoding</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getText" title="details" class="method-name">getText</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$brief</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getValue" title="details" class="method-name">getValue</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#setValue" title="details" class="method-name">setValue</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$comment</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span> = <span class="var-default">'ASCII'</span>])
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../PEL/PelEntry.html">PelEntry</a></span></p>
					<blockquote>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$bytes">PelEntry::$bytes</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$components">PelEntry::$components</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$format">PelEntry::$format</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$ifd_type">PelEntry::$ifd_type</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$tag">PelEntry::$tag</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a230">230</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make a new entry for holding a user comment.</p>
	
	<div class="method-signature">
		<span class="method-result">PelEntryUserComment</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$comment</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span> = <span class="var-default">'ASCII'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$comment</span><span class="var-description">: the new user comment.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$encoding</span><span class="var-description">: the encoding of the comment.  This should be either  'ASCII', 'JIS', 'Unicode', or the empty string specifying an  undefined encoding.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntryUndefined.html#method__construct">PelEntryUndefined::__construct()</a></dt>
						<dd>Make a new PelEntry that can hold undefined data.</dd>
					</dl>
			
	</div>
<a name="methodgetEncoding" id="getEncoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getEncoding</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a271">271</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the encoding.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the encoding of the user comment.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getEncoding
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetText" id="getText"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getText</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a281">281</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user comment.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the user comment.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getText
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$brief</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$brief</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntryUndefined.html#methodgetText">PelEntryUndefined::getText()</a></dt>
						<dd>Get the value of this entry as text.</dd>
					</dl>
			
	</div>
<a name="methodgetValue" id="getValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getValue</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a261">261</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user comment.</p>
<p class="description"><p>The comment is returned with the same character encoding as when  it was set using <a href="../PEL/PelEntryUserComment.html#methodsetValue">setValue</a> or <a href="../PEL/PelEntryUserComment.html#method__construct">the  constructor</a>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the user comment.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getValue
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntryUndefined.html#methodgetValue">PelEntryUndefined::getValue()</a></dt>
						<dd>Get the data of this undefined entry.</dd>
					</dl>
			
	</div>
<a name="methodsetValue" id="setValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">setValue</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryUndefined.php.html#a245">245</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the user comment.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setValue
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$comment</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span> = <span class="var-default">'ASCII'</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$comment</span><span class="var-description">: the new user comment.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$encoding</span><span class="var-description">: the encoding of the comment.  This should be either  'ASCII', 'JIS', 'Unicode', or the empty string specifying an  unknown encoding.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntryUndefined.html#methodsetValue">PelEntryUndefined::setValue()</a></dt>
						<dd>Set the data of this undefined entry.</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PEL/PelEntryUndefined.html">PelEntryUndefined</a></span></p>
					<blockquote>
													<img src="../media/images/Constructor.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntryUndefined.html#method__construct">PelEntryUndefined::__construct()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntryUndefined.html#methodgetText">PelEntryUndefined::getText()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntryUndefined.html#methodgetValue">PelEntryUndefined::getValue()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntryUndefined.html#methodsetValue">PelEntryUndefined::setValue()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PEL/PelEntry.html">PelEntry</a></span></p>
					<blockquote>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetBytes">PelEntry::getBytes()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetComponents">PelEntry::getComponents()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetFormat">PelEntry::getFormat()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetIfdType">PelEntry::getIfdType()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetTag">PelEntry::getTag()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetText">PelEntry::getText()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetValue">PelEntry::getValue()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodsetIfdType">PelEntry::setIfdType()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodsetValue">PelEntry::setValue()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#method__toString">PelEntry::__toString()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 19 Dec 2006 01:08:24 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
                <a target="_top" href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=108380&amp;type=1" width="88" height="31" border="0" align="right" alt="SourceForge.net Logo" /></a>
	</p>
	</div></body>
</html>